feat: ensure CRD comments are clean#85
Merged
scottlee01818 merged 3 commits intoJul 10, 2026
Merged
Conversation
The following requirements apply to keep the generated CRDs clean: 1. Default value ends up on its own line. 2. Individual lines are limited to 80 chars each. They are wrapped at 80 chars. 3. Kubebuilder comments are not wrapped so that they may continue to modify CRDs as we see fit. 4. Blocks have spaces between them. Signed-off-by: Scott Lee <scott.lee01818@gmail.com>
|
| Filename | Overview |
|---|---|
| internal/workload/v1/markers/markers.go | Adds five new helpers for clean CRD comment generation; wordRe is correctly package-level; logic is sound |
| internal/workload/v1/markers/markers_internal_test.go | Adds tests for all four user-facing helpers; one test case comment claims '80 characters exactly' but the string is 78 chars |
| internal/workload/v1/markers/field_marker.go | Adds GetComments method delegating to commentsFromMarker; straightforward and correct |
| internal/workload/v1/markers/collection_field_marker.go | Adds GetComments method delegating to commentsFromMarker; mirrors the FieldMarker change correctly |
| internal/workload/v1/kinds/workload.go | Replaces raw strings.Split with marker.GetComments, delegating all formatting to the new helpers |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["marker.GetComments('+kubebuilder:')"] --> B["commentsFromMarker(description, exceptions)"]
B --> C{"description empty after newline trim?"}
C -- yes --> D["return nil"]
C -- no --> E["prepend leading blank"]
E --> F["buildDescriptionBlocks"]
F --> G["paragraph blocks"]
G --> I["for each block"]
I --> J["wrapCommentBlock"]
J --> K{"exception prefix?"}
K -- yes --> L["emit verbatim"]
K -- no --> M["accumulate pending"]
M --> N["wrapCommentLine"]
N --> O{"text over 80 chars?"}
O -- no --> P["single line"]
O -- yes --> Q["split at word boundary"]
L --> R["block result"]
P --> R
Q --> R
R --> S["blank between blocks"]
S --> T["normalizeCommentLines"]
T --> U["comments passed to AddField"]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A["marker.GetComments('+kubebuilder:')"] --> B["commentsFromMarker(description, exceptions)"]
B --> C{"description empty after newline trim?"}
C -- yes --> D["return nil"]
C -- no --> E["prepend leading blank"]
E --> F["buildDescriptionBlocks"]
F --> G["paragraph blocks"]
G --> I["for each block"]
I --> J["wrapCommentBlock"]
J --> K{"exception prefix?"}
K -- yes --> L["emit verbatim"]
K -- no --> M["accumulate pending"]
M --> N["wrapCommentLine"]
N --> O{"text over 80 chars?"}
O -- no --> P["single line"]
O -- yes --> Q["split at word boundary"]
L --> R["block result"]
P --> R
Q --> R
R --> S["blank between blocks"]
S --> T["normalizeCommentLines"]
T --> U["comments passed to AddField"]
Reviews (4): Last reviewed commit: "test: add unit tests for new functions" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Signed-off-by: Scott Lee <scott.lee01818@gmail.com>
Signed-off-by: Scott Lee <scott.lee01818@gmail.com>
scottlee01818
force-pushed
the
feature/crd-comments-clean
branch
from
d9f1911 to
01dab68
Compare
lander2k2
approved these changes
Jul 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The following requirements apply to keep the generated CRDs clean: